<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class Randomizer</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Interface Randomizer
</h2> (line <span class="linenumber">45</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_Randomizer.php.html">/Randomizer.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Use this ESAPI security control to get random numbers and strings.</h5>
<div class="desc"><p>The idea behind this interface is to define a set of functions for  creating better random numbers and strings.</p></div>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Andrew van der Stock &lt;<a href="mailto:vanderaj@owasp.org">vanderaj@owasp.org</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodgetRandomBoolean" title="details" class="method-name">getRandomBoolean</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetRandomFilename" title="details" class="method-name">getRandomFilename</a>
        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$extension</span> = <span class="var-default">''</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetRandomGUID" title="details" class="method-name">getRandomGUID</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetRandomInteger" title="details" class="method-name">getRandomInteger</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$min</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$max</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetRandomLong" title="details" class="method-name">getRandomLong</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">float</span>
        <a href="#methodgetRandomReal" title="details" class="method-name">getRandomReal</a>
        (<span class="var-type">float</span>&nbsp;<span class="var-name">$min</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$max</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetRandomString" title="details" class="method-name">getRandomString</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$length</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$characterSet</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methodgetRandomBoolean" id="methodgetRandomBoolean"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomBoolean</strong> (line <span class="linenumber">78</span>)
 </h4> 
<h4><i>bool</i> <strong>getRandomBoolean(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns a random boolean.  The use of java.security.SecureRandom</h5>
<div class="desc"><p>is recommended because it provides a cryptographically strong  pseudo-random number generator. If SecureRandom is not used, the  pseudo-random number gernerator used should comply with the  statistical random number generator tests specified in  &lt;a href=&quot;http://csrc.nist.gov/cryptval/140-2.htm&quot;&gt;  FIPS 140-2, Security Requirements for Cryptographic Modules&lt;/a&gt;,  section 4.9.1.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true or false, randomly</li>
		</ul>
</div>
<a name="methodgetRandomFilename" id="methodgetRandomFilename"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomFilename</strong> (line <span class="linenumber">124</span>)
 </h4> 
<h4><i>string</i> <strong>getRandomFilename(
[string
$extension = ''])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns an unguessable random filename with the specified extension.</h5>
<div class="desc"><p>This method could call getRandomString(length, charset) from this  Class with the desired length and alphanumerics as the charset  then merely append &quot;.&quot; + extension.</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $extension</strong>: extension to add to the random filename</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - a random unguessable filename ending with the specified                 extension</li>
		</ul>
</div>
<a name="methodgetRandomGUID" id="methodgetRandomGUID"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomGUID</strong> (line <span class="linenumber">151</span>)
 </h4> 
<h4><i>string</i> <strong>getRandomGUID(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Generates a random GUID.  This method could use a hash of random Strings,  the current time, and any other random data available.  The format is a  well-defined sequence of 32 hex digits grouped into chunks of 8-4-4-4-12.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the GUID</li>
			<li><strong>throws</strong> - EncryptionException if hashing or encryption fails</li>
		</ul>
</div>
<a name="methodgetRandomInteger" id="methodgetRandomInteger"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomInteger</strong> (line <span class="linenumber">95</span>)
 </h4> 
<h4><i>int</i> <strong>getRandomInteger(
int
$min, int
$max)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the random integer. The use of java.security.SecureRandom</h5>
<div class="desc"><p>is recommended because it provides a cryptographically strong  pseudo-random number generator. If SecureRandom is not used, the   pseudo-random number gernerator used should comply with the  statistical random number generator tests specified in  &lt;a href=&quot;http://csrc.nist.gov/cryptval/140-2.htm&quot;&gt;  FIPS 140-2, Security Requirements for Cryptographic Modules&lt;/a&gt;,  section 4.9.1.</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $min</strong>: the minimum integer that will be returned</li>
			<li><strong>int $max</strong>: the maximum integer that will be returned</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the random integer</li>
		</ul>
</div>
<a name="methodgetRandomLong" id="methodgetRandomLong"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomLong</strong> (line <span class="linenumber">110</span>)
 </h4> 
<h4><i>int</i> <strong>getRandomLong(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the random long. The use of java.security.SecureRandom</h5>
<div class="desc"><p>is recommended because it provides a cryptographically strong  pseudo-random number generator. If SecureRandom is not used, the  pseudo-random number gernerator used should comply with the  statistical random number generator tests specified in  &lt;a href=&quot;http://csrc.nist.gov/cryptval/140-2.htm&quot;&gt;  FIPS 140-2, Security Requirements for Cryptographic Modules&lt;/a&gt;,  section 4.9.1.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the random long</li>
		</ul>
</div>
<a name="methodgetRandomReal" id="methodgetRandomReal"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomReal</strong> (line <span class="linenumber">141</span>)
 </h4> 
<h4><i>float</i> <strong>getRandomReal(
float
$min, float
$max)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the random real.  The use of java.security.SecureRandom</h5>
<div class="desc"><p>is recommended because it provides a cryptographically strong pseudo-random  number generator. If SecureRandom is not used, the pseudo-random number  generator used should comply with the statistical random number generator  tests specified in &lt;a href=&quot;http://csrc.nist.gov/cryptval/140-2.htm&quot;&gt;  FIPS 140-2, Security Requirements for Cryptographic Modules&lt;/a&gt;, section  4.9.1.</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>float $min</strong>: the minimum real number that will be returned</li>
			<li><strong>float $max</strong>: the maximum real number that will be returned</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the random real</li>
		</ul>
</div>
<a name="methodgetRandomString" id="methodgetRandomString"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomString</strong> (line <span class="linenumber">64</span>)
 </h4> 
<h4><i>string</i> <strong>getRandomString(
int
$length, string
$characterSet)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets a random string of a desired length and character set.  The use of</h5>
<div class="desc"><p>java.security.SecureRandom is recommended because it provides a  cryptographically strong pseudo-random number generator. If SecureRandom  is not used, the pseudo-random number gernerator used should comply with the  statistical random number generator tests specified in  &lt;a href=&quot;http://csrc.nist.gov/cryptval/140-2.htm&quot;&gt;  FIPS 140-2, Security Requirements for Cryptographic Modules&lt;/a&gt;, section  4.9.1.</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $length</strong>: the length of the string</li>
			<li><strong>string $characterSet</strong>: the set of characters to include in the created                              random string</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the random string of the desired length and character set</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 14:53:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>